const express = require('express');
const router = express.Router();
const Favorite = require('../../../controller/system/favorite-controller');

/**
 * 创建 - 创建收藏
 * @route POST /api/private/favorite/create
 * @group 收藏管理 - 创建
 * @param {string} type - 网站类别
 * @param {string} typeName - 网站类别名称
 * @param {string} name - 网站名称
 * @param {string} cover - 网站图标
 * @param {string} url - 网站地址
 * @param {string} desc - 网站简介
 * @param {Boolean} state - 状态
 * @returns {object} 200 - 用户信息
 * @returns {object} 605 - 请求失败错误
 * @returns {Error}  default - Unexpected error
 */
router.post('/create', Favorite.create);

/**
 * 查询 - 收藏列表
 * @route POST /api/private/favorite/list
 * @group 收藏管理 - 列表
 * @param {object} query - 请按固定查询规范
 * @returns {object} 200 - 用户信息
 * @returns {object} 605 - 请求失败错误
 * @returns {Error}  default - Unexpected error
 */
router.post('/list', Favorite.findAll);

/**
 * 查询 - 根据id
 * @route POST /api/private/favorite/findOne
 * @group 收藏管理 - 查询
 * @param {string} id - 信息id
 * @returns {object} 200 - 用户信息
 * @returns {object} 605 - 请求失败错误
 * @returns {Error}  default - Unexpected error
 */
router.post("/findOne", Favorite.findOne);

/**
 * 更新
 * @route POST /api/private/favorite/update
 * @group 收藏管理 - 更新
 * @param {object} query - 请按固定查询规范
 * @returns {object} 200 - 用户信息
 * @returns {object} 605 - 请求失败错误
 * @returns {Error}  default - Unexpected error
 */
router.post("/update", Favorite.update);

/**
 * 删除 - 根据id
 * @route POST /api/private/favorite/delete
 * @group 收藏管理 - 删除
 * @param {string} id - 信息id
 * @returns {object} 200 - 用户信息
 * @returns {object} 605 - 请求失败错误
 * @returns {Error}  default - Unexpected error
 */
router.post("/delete", Favorite.delete);

/**
 * 删除所有信息
 * @route POST /api/private/favorite/deleteAll
 * @group 收藏管理 - 删除所有信息
 * @returns {object} 200 - 用户信息
 * @returns {object} 605 - 请求失败错误
 * @returns {Error}  default - Unexpected error
 */
router.post("/deleteAll", Favorite.deleteAll);

module.exports = router;